<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>package org.apache.commons.net.ntp;<a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.3"></a>
<span class="sourceLineNo">004</span> * contributor license agreements.  See the NOTICE file distributed with<a name="line.4"></a>
<span class="sourceLineNo">005</span> * this work for additional information regarding copyright ownership.<a name="line.5"></a>
<span class="sourceLineNo">006</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.6"></a>
<span class="sourceLineNo">007</span> * (the "License"); you may not use this file except in compliance with<a name="line.7"></a>
<span class="sourceLineNo">008</span> * the License.  You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a>
<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.text.DateFormat;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.text.SimpleDateFormat;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.Date;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.Locale;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.TimeZone;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>/***<a name="line.27"></a>
<span class="sourceLineNo">028</span> * TimeStamp class represents the Network Time Protocol (NTP) timestamp<a name="line.28"></a>
<span class="sourceLineNo">029</span> * as defined in RFC-1305 and SNTP (RFC-2030). It is represented as a<a name="line.29"></a>
<span class="sourceLineNo">030</span> * 64-bit unsigned fixed-point number in seconds relative to 0-hour on 1-January-1900.<a name="line.30"></a>
<span class="sourceLineNo">031</span> * The 32-bit low-order bits are the fractional seconds whose precision is<a name="line.31"></a>
<span class="sourceLineNo">032</span> * about 200 picoseconds. Assumes overflow date when date passes MAX_LONG<a name="line.32"></a>
<span class="sourceLineNo">033</span> * and reverts back to 0 is 2036 and not 1900. Test for most significant<a name="line.33"></a>
<span class="sourceLineNo">034</span> * bit: if MSB=0 then 2036 basis is used otherwise 1900 if MSB=1.<a name="line.34"></a>
<span class="sourceLineNo">035</span> * &lt;p&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> * Methods exist to convert NTP timestamps to and from the equivalent Java date<a name="line.36"></a>
<span class="sourceLineNo">037</span> * representation, which is the number of milliseconds since the standard base<a name="line.37"></a>
<span class="sourceLineNo">038</span> * time known as "the epoch", namely January 1, 1970, 00:00:00 GMT.<a name="line.38"></a>
<span class="sourceLineNo">039</span> * &lt;/p&gt;<a name="line.39"></a>
<span class="sourceLineNo">040</span> *<a name="line.40"></a>
<span class="sourceLineNo">041</span> * @author Jason Mathews, MITRE Corp<a name="line.41"></a>
<span class="sourceLineNo">042</span> * @version $Revision: 1489361 $<a name="line.42"></a>
<span class="sourceLineNo">043</span> * @see java.util.Date<a name="line.43"></a>
<span class="sourceLineNo">044</span> */<a name="line.44"></a>
<span class="sourceLineNo">045</span>public class TimeStamp implements java.io.Serializable, Comparable&lt;TimeStamp&gt;<a name="line.45"></a>
<span class="sourceLineNo">046</span>{<a name="line.46"></a>
<span class="sourceLineNo">047</span>    private static final long serialVersionUID = 8139806907588338737L;<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span>    /**<a name="line.49"></a>
<span class="sourceLineNo">050</span>     * baseline NTP time if bit-0=0 -&gt; 7-Feb-2036 @ 06:28:16 UTC<a name="line.50"></a>
<span class="sourceLineNo">051</span>     */<a name="line.51"></a>
<span class="sourceLineNo">052</span>    protected static final long msb0baseTime = 2085978496000L;<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span>    /**<a name="line.54"></a>
<span class="sourceLineNo">055</span>     *  baseline NTP time if bit-0=1 -&gt; 1-Jan-1900 @ 01:00:00 UTC<a name="line.55"></a>
<span class="sourceLineNo">056</span>     */<a name="line.56"></a>
<span class="sourceLineNo">057</span>    protected static final long msb1baseTime = -2208988800000L;<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span>    /**<a name="line.59"></a>
<span class="sourceLineNo">060</span>     * Default NTP date string format. E.g. Fri, Sep 12 2003 21:06:23.860.<a name="line.60"></a>
<span class="sourceLineNo">061</span>     * See &lt;code&gt;java.text.SimpleDateFormat&lt;/code&gt; for code descriptions.<a name="line.61"></a>
<span class="sourceLineNo">062</span>     */<a name="line.62"></a>
<span class="sourceLineNo">063</span>    public final static String NTP_DATE_FORMAT = "EEE, MMM dd yyyy HH:mm:ss.SSS";<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span>    /**<a name="line.65"></a>
<span class="sourceLineNo">066</span>     * NTP timestamp value: 64-bit unsigned fixed-point number as defined in RFC-1305<a name="line.66"></a>
<span class="sourceLineNo">067</span>     * with high-order 32 bits the seconds field and the low-order 32-bits the<a name="line.67"></a>
<span class="sourceLineNo">068</span>     * fractional field.<a name="line.68"></a>
<span class="sourceLineNo">069</span>     */<a name="line.69"></a>
<span class="sourceLineNo">070</span>    private final long ntpTime;<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span>    private DateFormat simpleFormatter;<a name="line.72"></a>
<span class="sourceLineNo">073</span>    private DateFormat utcFormatter;<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span>    // initialization of static time bases<a name="line.75"></a>
<span class="sourceLineNo">076</span>    /*<a name="line.76"></a>
<span class="sourceLineNo">077</span>    static {<a name="line.77"></a>
<span class="sourceLineNo">078</span>        TimeZone utcZone = TimeZone.getTimeZone("UTC");<a name="line.78"></a>
<span class="sourceLineNo">079</span>        Calendar calendar = Calendar.getInstance(utcZone);<a name="line.79"></a>
<span class="sourceLineNo">080</span>        calendar.set(1900, Calendar.JANUARY, 1, 0, 0, 0);<a name="line.80"></a>
<span class="sourceLineNo">081</span>        calendar.set(Calendar.MILLISECOND, 0);<a name="line.81"></a>
<span class="sourceLineNo">082</span>        msb1baseTime = calendar.getTime().getTime();<a name="line.82"></a>
<span class="sourceLineNo">083</span>        calendar.set(2036, Calendar.FEBRUARY, 7, 6, 28, 16);<a name="line.83"></a>
<span class="sourceLineNo">084</span>        calendar.set(Calendar.MILLISECOND, 0);<a name="line.84"></a>
<span class="sourceLineNo">085</span>        msb0baseTime = calendar.getTime().getTime();<a name="line.85"></a>
<span class="sourceLineNo">086</span>    }<a name="line.86"></a>
<span class="sourceLineNo">087</span>    */<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span>    /***<a name="line.89"></a>
<span class="sourceLineNo">090</span>     * Constructs a newly allocated NTP timestamp object<a name="line.90"></a>
<span class="sourceLineNo">091</span>     * that represents the native 64-bit long argument.<a name="line.91"></a>
<span class="sourceLineNo">092</span>     */<a name="line.92"></a>
<span class="sourceLineNo">093</span>    public TimeStamp(long ntpTime)<a name="line.93"></a>
<span class="sourceLineNo">094</span>    {<a name="line.94"></a>
<span class="sourceLineNo">095</span>        this.ntpTime = ntpTime;<a name="line.95"></a>
<span class="sourceLineNo">096</span>    }<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span>    /***<a name="line.98"></a>
<span class="sourceLineNo">099</span>     * Constructs a newly allocated NTP timestamp object<a name="line.99"></a>
<span class="sourceLineNo">100</span>     * that represents the value represented by the string<a name="line.100"></a>
<span class="sourceLineNo">101</span>     * in hexdecimal form (e.g. "c1a089bd.fc904f6d").<a name="line.101"></a>
<span class="sourceLineNo">102</span>     *<a name="line.102"></a>
<span class="sourceLineNo">103</span>     * @throws NumberFormatException - if the string does not contain a parsable timestamp.<a name="line.103"></a>
<span class="sourceLineNo">104</span>     */<a name="line.104"></a>
<span class="sourceLineNo">105</span>    public TimeStamp(String s) throws NumberFormatException<a name="line.105"></a>
<span class="sourceLineNo">106</span>    {<a name="line.106"></a>
<span class="sourceLineNo">107</span>        ntpTime = decodeNtpHexString(s);<a name="line.107"></a>
<span class="sourceLineNo">108</span>    }<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span>    /***<a name="line.110"></a>
<span class="sourceLineNo">111</span>     * Constructs a newly allocated NTP timestamp object<a name="line.111"></a>
<span class="sourceLineNo">112</span>     * that represents the Java Date argument.<a name="line.112"></a>
<span class="sourceLineNo">113</span>     *<a name="line.113"></a>
<span class="sourceLineNo">114</span>     * @param d - the Date to be represented by the Timestamp object.<a name="line.114"></a>
<span class="sourceLineNo">115</span>     */<a name="line.115"></a>
<span class="sourceLineNo">116</span>    public TimeStamp(Date d)<a name="line.116"></a>
<span class="sourceLineNo">117</span>    {<a name="line.117"></a>
<span class="sourceLineNo">118</span>        ntpTime = (d == null) ? 0 : toNtpTime(d.getTime());<a name="line.118"></a>
<span class="sourceLineNo">119</span>    }<a name="line.119"></a>
<span class="sourceLineNo">120</span><a name="line.120"></a>
<span class="sourceLineNo">121</span>    /***<a name="line.121"></a>
<span class="sourceLineNo">122</span>     * Returns the value of this Timestamp as a long value.<a name="line.122"></a>
<span class="sourceLineNo">123</span>     *<a name="line.123"></a>
<span class="sourceLineNo">124</span>     * @return the 64-bit long value represented by this object.<a name="line.124"></a>
<span class="sourceLineNo">125</span>     */<a name="line.125"></a>
<span class="sourceLineNo">126</span>    public long ntpValue()<a name="line.126"></a>
<span class="sourceLineNo">127</span>    {<a name="line.127"></a>
<span class="sourceLineNo">128</span>        return ntpTime;<a name="line.128"></a>
<span class="sourceLineNo">129</span>    }<a name="line.129"></a>
<span class="sourceLineNo">130</span><a name="line.130"></a>
<span class="sourceLineNo">131</span>    /***<a name="line.131"></a>
<span class="sourceLineNo">132</span>     * Returns high-order 32-bits representing the seconds of this NTP timestamp.<a name="line.132"></a>
<span class="sourceLineNo">133</span>     *<a name="line.133"></a>
<span class="sourceLineNo">134</span>     * @return seconds represented by this NTP timestamp.<a name="line.134"></a>
<span class="sourceLineNo">135</span>     */<a name="line.135"></a>
<span class="sourceLineNo">136</span>    public long getSeconds()<a name="line.136"></a>
<span class="sourceLineNo">137</span>    {<a name="line.137"></a>
<span class="sourceLineNo">138</span>        return (ntpTime &gt;&gt;&gt; 32) &amp; 0xffffffffL;<a name="line.138"></a>
<span class="sourceLineNo">139</span>    }<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span>    /***<a name="line.141"></a>
<span class="sourceLineNo">142</span>     * Returns low-order 32-bits representing the fractional seconds.<a name="line.142"></a>
<span class="sourceLineNo">143</span>     *<a name="line.143"></a>
<span class="sourceLineNo">144</span>     * @return fractional seconds represented by this NTP timestamp.<a name="line.144"></a>
<span class="sourceLineNo">145</span>     */<a name="line.145"></a>
<span class="sourceLineNo">146</span>    public long getFraction()<a name="line.146"></a>
<span class="sourceLineNo">147</span>    {<a name="line.147"></a>
<span class="sourceLineNo">148</span>        return ntpTime &amp; 0xffffffffL;<a name="line.148"></a>
<span class="sourceLineNo">149</span>    }<a name="line.149"></a>
<span class="sourceLineNo">150</span><a name="line.150"></a>
<span class="sourceLineNo">151</span>    /***<a name="line.151"></a>
<span class="sourceLineNo">152</span>     * Convert NTP timestamp to Java standard time.<a name="line.152"></a>
<span class="sourceLineNo">153</span>     *<a name="line.153"></a>
<span class="sourceLineNo">154</span>     * @return NTP Timestamp in Java time<a name="line.154"></a>
<span class="sourceLineNo">155</span>     */<a name="line.155"></a>
<span class="sourceLineNo">156</span>    public long getTime()<a name="line.156"></a>
<span class="sourceLineNo">157</span>    {<a name="line.157"></a>
<span class="sourceLineNo">158</span>        return getTime(ntpTime);<a name="line.158"></a>
<span class="sourceLineNo">159</span>    }<a name="line.159"></a>
<span class="sourceLineNo">160</span><a name="line.160"></a>
<span class="sourceLineNo">161</span>    /***<a name="line.161"></a>
<span class="sourceLineNo">162</span>     * Convert NTP timestamp to Java Date object.<a name="line.162"></a>
<span class="sourceLineNo">163</span>     *<a name="line.163"></a>
<span class="sourceLineNo">164</span>     * @return NTP Timestamp in Java Date<a name="line.164"></a>
<span class="sourceLineNo">165</span>     */<a name="line.165"></a>
<span class="sourceLineNo">166</span>    public Date getDate()<a name="line.166"></a>
<span class="sourceLineNo">167</span>    {<a name="line.167"></a>
<span class="sourceLineNo">168</span>        long time = getTime(ntpTime);<a name="line.168"></a>
<span class="sourceLineNo">169</span>        return new Date(time);<a name="line.169"></a>
<span class="sourceLineNo">170</span>    }<a name="line.170"></a>
<span class="sourceLineNo">171</span><a name="line.171"></a>
<span class="sourceLineNo">172</span>    /***<a name="line.172"></a>
<span class="sourceLineNo">173</span>     * Convert 64-bit NTP timestamp to Java standard time.<a name="line.173"></a>
<span class="sourceLineNo">174</span>     *<a name="line.174"></a>
<span class="sourceLineNo">175</span>     * Note that java time (milliseconds) by definition has less precision<a name="line.175"></a>
<span class="sourceLineNo">176</span>     * then NTP time (picoseconds) so converting NTP timestamp to java time and back<a name="line.176"></a>
<span class="sourceLineNo">177</span>     * to NTP timestamp loses precision. For example, Tue, Dec 17 2002 09:07:24.810 EST<a name="line.177"></a>
<span class="sourceLineNo">178</span>     * is represented by a single Java-based time value of f22cd1fc8a, but its<a name="line.178"></a>
<span class="sourceLineNo">179</span>     * NTP equivalent are all values ranging from c1a9ae1c.cf5c28f5 to c1a9ae1c.cf9db22c.<a name="line.179"></a>
<span class="sourceLineNo">180</span>     *<a name="line.180"></a>
<span class="sourceLineNo">181</span>     * @param ntpTimeValue<a name="line.181"></a>
<span class="sourceLineNo">182</span>     * @return the number of milliseconds since January 1, 1970, 00:00:00 GMT<a name="line.182"></a>
<span class="sourceLineNo">183</span>     * represented by this NTP timestamp value.<a name="line.183"></a>
<span class="sourceLineNo">184</span>     */<a name="line.184"></a>
<span class="sourceLineNo">185</span>    public static long getTime(long ntpTimeValue)<a name="line.185"></a>
<span class="sourceLineNo">186</span>    {<a name="line.186"></a>
<span class="sourceLineNo">187</span>        long seconds = (ntpTimeValue &gt;&gt;&gt; 32) &amp; 0xffffffffL;     // high-order 32-bits<a name="line.187"></a>
<span class="sourceLineNo">188</span>        long fraction = ntpTimeValue &amp; 0xffffffffL;             // low-order 32-bits<a name="line.188"></a>
<span class="sourceLineNo">189</span><a name="line.189"></a>
<span class="sourceLineNo">190</span>        // Use round-off on fractional part to preserve going to lower precision<a name="line.190"></a>
<span class="sourceLineNo">191</span>        fraction = Math.round(1000D * fraction / 0x100000000L);<a name="line.191"></a>
<span class="sourceLineNo">192</span><a name="line.192"></a>
<span class="sourceLineNo">193</span>        /*<a name="line.193"></a>
<span class="sourceLineNo">194</span>         * If the most significant bit (MSB) on the seconds field is set we use<a name="line.194"></a>
<span class="sourceLineNo">195</span>         * a different time base. The following text is a quote from RFC-2030 (SNTP v4):<a name="line.195"></a>
<span class="sourceLineNo">196</span>         *<a name="line.196"></a>
<span class="sourceLineNo">197</span>         *  If bit 0 is set, the UTC time is in the range 1968-2036 and UTC time<a name="line.197"></a>
<span class="sourceLineNo">198</span>         *  is reckoned from 0h 0m 0s UTC on 1 January 1900. If bit 0 is not set,<a name="line.198"></a>
<span class="sourceLineNo">199</span>         *  the time is in the range 2036-2104 and UTC time is reckoned from<a name="line.199"></a>
<span class="sourceLineNo">200</span>         *  6h 28m 16s UTC on 7 February 2036.<a name="line.200"></a>
<span class="sourceLineNo">201</span>         */<a name="line.201"></a>
<span class="sourceLineNo">202</span>        long msb = seconds &amp; 0x80000000L;<a name="line.202"></a>
<span class="sourceLineNo">203</span>        if (msb == 0) {<a name="line.203"></a>
<span class="sourceLineNo">204</span>            // use base: 7-Feb-2036 @ 06:28:16 UTC<a name="line.204"></a>
<span class="sourceLineNo">205</span>            return msb0baseTime + (seconds * 1000) + fraction;<a name="line.205"></a>
<span class="sourceLineNo">206</span>        } else {<a name="line.206"></a>
<span class="sourceLineNo">207</span>            // use base: 1-Jan-1900 @ 01:00:00 UTC<a name="line.207"></a>
<span class="sourceLineNo">208</span>            return msb1baseTime + (seconds * 1000) + fraction;<a name="line.208"></a>
<span class="sourceLineNo">209</span>        }<a name="line.209"></a>
<span class="sourceLineNo">210</span>    }<a name="line.210"></a>
<span class="sourceLineNo">211</span><a name="line.211"></a>
<span class="sourceLineNo">212</span>    /***<a name="line.212"></a>
<span class="sourceLineNo">213</span>     * Helper method to convert Java time to NTP timestamp object.<a name="line.213"></a>
<span class="sourceLineNo">214</span>     * Note that Java time (milliseconds) by definition has less precision<a name="line.214"></a>
<span class="sourceLineNo">215</span>     * then NTP time (picoseconds) so converting Ntptime to Javatime and back<a name="line.215"></a>
<span class="sourceLineNo">216</span>     * to Ntptime loses precision. For example, Tue, Dec 17 2002 09:07:24.810<a name="line.216"></a>
<span class="sourceLineNo">217</span>     * is represented by a single Java-based time value of f22cd1fc8a, but its<a name="line.217"></a>
<span class="sourceLineNo">218</span>     * NTP equivalent are all values from c1a9ae1c.cf5c28f5 to c1a9ae1c.cf9db22c.<a name="line.218"></a>
<span class="sourceLineNo">219</span>     * @param   date   the milliseconds since January 1, 1970, 00:00:00 GMT.<a name="line.219"></a>
<span class="sourceLineNo">220</span>     * @return NTP timestamp object at the specified date.<a name="line.220"></a>
<span class="sourceLineNo">221</span>     */<a name="line.221"></a>
<span class="sourceLineNo">222</span>    public static TimeStamp getNtpTime(long date)<a name="line.222"></a>
<span class="sourceLineNo">223</span>    {<a name="line.223"></a>
<span class="sourceLineNo">224</span>        return new TimeStamp(toNtpTime(date));<a name="line.224"></a>
<span class="sourceLineNo">225</span>    }<a name="line.225"></a>
<span class="sourceLineNo">226</span><a name="line.226"></a>
<span class="sourceLineNo">227</span>    /***<a name="line.227"></a>
<span class="sourceLineNo">228</span>     * Constructs a NTP timestamp object and initializes it so that<a name="line.228"></a>
<span class="sourceLineNo">229</span>     * it represents the time at which it was allocated, measured to the<a name="line.229"></a>
<span class="sourceLineNo">230</span>     * nearest millisecond.<a name="line.230"></a>
<span class="sourceLineNo">231</span>     * @return NTP timestamp object set to the current time.<a name="line.231"></a>
<span class="sourceLineNo">232</span>     * @see     java.lang.System#currentTimeMillis()<a name="line.232"></a>
<span class="sourceLineNo">233</span>     */<a name="line.233"></a>
<span class="sourceLineNo">234</span>    public static TimeStamp getCurrentTime()<a name="line.234"></a>
<span class="sourceLineNo">235</span>    {<a name="line.235"></a>
<span class="sourceLineNo">236</span>        return getNtpTime(System.currentTimeMillis());<a name="line.236"></a>
<span class="sourceLineNo">237</span>    }<a name="line.237"></a>
<span class="sourceLineNo">238</span><a name="line.238"></a>
<span class="sourceLineNo">239</span>    /***<a name="line.239"></a>
<span class="sourceLineNo">240</span>     * Convert NTP timestamp hexstring (e.g. "c1a089bd.fc904f6d") to the NTP<a name="line.240"></a>
<span class="sourceLineNo">241</span>     * 64-bit unsigned fixed-point number.<a name="line.241"></a>
<span class="sourceLineNo">242</span>     *<a name="line.242"></a>
<span class="sourceLineNo">243</span>     * @return NTP 64-bit timestamp value.<a name="line.243"></a>
<span class="sourceLineNo">244</span>     * @throws NumberFormatException - if the string does not contain a parsable timestamp.<a name="line.244"></a>
<span class="sourceLineNo">245</span>     */<a name="line.245"></a>
<span class="sourceLineNo">246</span>    protected static long decodeNtpHexString(String s)<a name="line.246"></a>
<span class="sourceLineNo">247</span>            throws NumberFormatException<a name="line.247"></a>
<span class="sourceLineNo">248</span>    {<a name="line.248"></a>
<span class="sourceLineNo">249</span>        if (s == null) {<a name="line.249"></a>
<span class="sourceLineNo">250</span>            throw new NumberFormatException("null");<a name="line.250"></a>
<span class="sourceLineNo">251</span>        }<a name="line.251"></a>
<span class="sourceLineNo">252</span>        int ind = s.indexOf('.');<a name="line.252"></a>
<span class="sourceLineNo">253</span>        if (ind == -1) {<a name="line.253"></a>
<span class="sourceLineNo">254</span>            if (s.length() == 0) {<a name="line.254"></a>
<span class="sourceLineNo">255</span>                return 0;<a name="line.255"></a>
<span class="sourceLineNo">256</span>            }<a name="line.256"></a>
<span class="sourceLineNo">257</span>            return Long.parseLong(s, 16) &lt;&lt; 32; // no decimal<a name="line.257"></a>
<span class="sourceLineNo">258</span>        }<a name="line.258"></a>
<span class="sourceLineNo">259</span><a name="line.259"></a>
<span class="sourceLineNo">260</span>        return Long.parseLong(s.substring(0, ind), 16) &lt;&lt; 32 |<a name="line.260"></a>
<span class="sourceLineNo">261</span>                Long.parseLong(s.substring(ind + 1), 16);<a name="line.261"></a>
<span class="sourceLineNo">262</span>    }<a name="line.262"></a>
<span class="sourceLineNo">263</span><a name="line.263"></a>
<span class="sourceLineNo">264</span>    /***<a name="line.264"></a>
<span class="sourceLineNo">265</span>     * Parses the string argument as a NTP hexidecimal timestamp representation string<a name="line.265"></a>
<span class="sourceLineNo">266</span>     * (e.g. "c1a089bd.fc904f6d").<a name="line.266"></a>
<span class="sourceLineNo">267</span>     *<a name="line.267"></a>
<span class="sourceLineNo">268</span>     * @param s - hexstring.<a name="line.268"></a>
<span class="sourceLineNo">269</span>     * @return the Timestamp represented by the argument in hexidecimal.<a name="line.269"></a>
<span class="sourceLineNo">270</span>     * @throws NumberFormatException - if the string does not contain a parsable timestamp.<a name="line.270"></a>
<span class="sourceLineNo">271</span>     */<a name="line.271"></a>
<span class="sourceLineNo">272</span>    public static TimeStamp parseNtpString(String s)<a name="line.272"></a>
<span class="sourceLineNo">273</span>            throws NumberFormatException<a name="line.273"></a>
<span class="sourceLineNo">274</span>    {<a name="line.274"></a>
<span class="sourceLineNo">275</span>        return new TimeStamp(decodeNtpHexString(s));<a name="line.275"></a>
<span class="sourceLineNo">276</span>    }<a name="line.276"></a>
<span class="sourceLineNo">277</span><a name="line.277"></a>
<span class="sourceLineNo">278</span>    /***<a name="line.278"></a>
<span class="sourceLineNo">279</span>     * Converts Java time to 64-bit NTP time representation.<a name="line.279"></a>
<span class="sourceLineNo">280</span>     *<a name="line.280"></a>
<span class="sourceLineNo">281</span>     * @param t Java time<a name="line.281"></a>
<span class="sourceLineNo">282</span>     * @return NTP timestamp representation of Java time value.<a name="line.282"></a>
<span class="sourceLineNo">283</span>     */<a name="line.283"></a>
<span class="sourceLineNo">284</span>    protected static long toNtpTime(long t)<a name="line.284"></a>
<span class="sourceLineNo">285</span>    {<a name="line.285"></a>
<span class="sourceLineNo">286</span>        boolean useBase1 = t &lt; msb0baseTime;    // time &lt; Feb-2036<a name="line.286"></a>
<span class="sourceLineNo">287</span>        long baseTime;<a name="line.287"></a>
<span class="sourceLineNo">288</span>        if (useBase1) {<a name="line.288"></a>
<span class="sourceLineNo">289</span>            baseTime = t - msb1baseTime; // dates &lt;= Feb-2036<a name="line.289"></a>
<span class="sourceLineNo">290</span>        } else {<a name="line.290"></a>
<span class="sourceLineNo">291</span>            // if base0 needed for dates &gt;= Feb-2036<a name="line.291"></a>
<span class="sourceLineNo">292</span>            baseTime = t - msb0baseTime;<a name="line.292"></a>
<span class="sourceLineNo">293</span>        }<a name="line.293"></a>
<span class="sourceLineNo">294</span><a name="line.294"></a>
<span class="sourceLineNo">295</span>        long seconds = baseTime / 1000;<a name="line.295"></a>
<span class="sourceLineNo">296</span>        long fraction = ((baseTime % 1000) * 0x100000000L) / 1000;<a name="line.296"></a>
<span class="sourceLineNo">297</span><a name="line.297"></a>
<span class="sourceLineNo">298</span>        if (useBase1) {<a name="line.298"></a>
<span class="sourceLineNo">299</span>            seconds |= 0x80000000L; // set high-order bit if msb1baseTime 1900 used<a name="line.299"></a>
<span class="sourceLineNo">300</span>        }<a name="line.300"></a>
<span class="sourceLineNo">301</span><a name="line.301"></a>
<span class="sourceLineNo">302</span>        long time = seconds &lt;&lt; 32 | fraction;<a name="line.302"></a>
<span class="sourceLineNo">303</span>        return time;<a name="line.303"></a>
<span class="sourceLineNo">304</span>    }<a name="line.304"></a>
<span class="sourceLineNo">305</span><a name="line.305"></a>
<span class="sourceLineNo">306</span>    /***<a name="line.306"></a>
<span class="sourceLineNo">307</span>     * Computes a hashcode for this Timestamp. The result is the exclusive<a name="line.307"></a>
<span class="sourceLineNo">308</span>     * OR of the two halves of the primitive &lt;code&gt;long&lt;/code&gt; value<a name="line.308"></a>
<span class="sourceLineNo">309</span>     * represented by this &lt;code&gt;TimeStamp&lt;/code&gt; object. That is, the hashcode<a name="line.309"></a>
<span class="sourceLineNo">310</span>     * is the value of the expression:<a name="line.310"></a>
<span class="sourceLineNo">311</span>     * &lt;blockquote&gt;&lt;pre&gt;<a name="line.311"></a>
<span class="sourceLineNo">312</span>     * (int)(this.ntpValue()^(this.ntpValue() &gt;&gt;&gt; 32))<a name="line.312"></a>
<span class="sourceLineNo">313</span>     * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.313"></a>
<span class="sourceLineNo">314</span>     *<a name="line.314"></a>
<span class="sourceLineNo">315</span>     * @return  a hash code value for this object.<a name="line.315"></a>
<span class="sourceLineNo">316</span>     */<a name="line.316"></a>
<span class="sourceLineNo">317</span>    @Override<a name="line.317"></a>
<span class="sourceLineNo">318</span>    public int hashCode()<a name="line.318"></a>
<span class="sourceLineNo">319</span>    {<a name="line.319"></a>
<span class="sourceLineNo">320</span>        return (int) (ntpTime ^ (ntpTime &gt;&gt;&gt; 32));<a name="line.320"></a>
<span class="sourceLineNo">321</span>    }<a name="line.321"></a>
<span class="sourceLineNo">322</span><a name="line.322"></a>
<span class="sourceLineNo">323</span>    /***<a name="line.323"></a>
<span class="sourceLineNo">324</span>     * Compares this object against the specified object.<a name="line.324"></a>
<span class="sourceLineNo">325</span>     * The result is &lt;code&gt;true&lt;/code&gt; if and only if the argument is<a name="line.325"></a>
<span class="sourceLineNo">326</span>     * not &lt;code&gt;null&lt;/code&gt; and is a &lt;code&gt;Long&lt;/code&gt; object that<a name="line.326"></a>
<span class="sourceLineNo">327</span>     * contains the same &lt;code&gt;long&lt;/code&gt; value as this object.<a name="line.327"></a>
<span class="sourceLineNo">328</span>     *<a name="line.328"></a>
<span class="sourceLineNo">329</span>     * @param   obj   the object to compare with.<a name="line.329"></a>
<span class="sourceLineNo">330</span>     * @return  &lt;code&gt;true&lt;/code&gt; if the objects are the same;<a name="line.330"></a>
<span class="sourceLineNo">331</span>     *          &lt;code&gt;false&lt;/code&gt; otherwise.<a name="line.331"></a>
<span class="sourceLineNo">332</span>     */<a name="line.332"></a>
<span class="sourceLineNo">333</span>    @Override<a name="line.333"></a>
<span class="sourceLineNo">334</span>    public boolean equals(Object obj)<a name="line.334"></a>
<span class="sourceLineNo">335</span>    {<a name="line.335"></a>
<span class="sourceLineNo">336</span>        if (obj instanceof TimeStamp) {<a name="line.336"></a>
<span class="sourceLineNo">337</span>            return ntpTime == ((TimeStamp) obj).ntpValue();<a name="line.337"></a>
<span class="sourceLineNo">338</span>        }<a name="line.338"></a>
<span class="sourceLineNo">339</span>        return false;<a name="line.339"></a>
<span class="sourceLineNo">340</span>    }<a name="line.340"></a>
<span class="sourceLineNo">341</span><a name="line.341"></a>
<span class="sourceLineNo">342</span>    /***<a name="line.342"></a>
<span class="sourceLineNo">343</span>     * Converts this &lt;code&gt;TimeStamp&lt;/code&gt; object to a &lt;code&gt;String&lt;/code&gt;.<a name="line.343"></a>
<span class="sourceLineNo">344</span>     * The NTP timestamp 64-bit long value is represented as hex string with<a name="line.344"></a>
<span class="sourceLineNo">345</span>     * seconds separated by fractional seconds by a decimal point;<a name="line.345"></a>
<span class="sourceLineNo">346</span>     * e.g. c1a089bd.fc904f6d &lt;=&gt; Tue, Dec 10 2002 10:41:49.986<a name="line.346"></a>
<span class="sourceLineNo">347</span>     *<a name="line.347"></a>
<span class="sourceLineNo">348</span>     * @return NTP timestamp 64-bit long value as hex string with seconds<a name="line.348"></a>
<span class="sourceLineNo">349</span>     * separated by fractional seconds.<a name="line.349"></a>
<span class="sourceLineNo">350</span>     */<a name="line.350"></a>
<span class="sourceLineNo">351</span>    @Override<a name="line.351"></a>
<span class="sourceLineNo">352</span>    public String toString()<a name="line.352"></a>
<span class="sourceLineNo">353</span>    {<a name="line.353"></a>
<span class="sourceLineNo">354</span>        return toString(ntpTime);<a name="line.354"></a>
<span class="sourceLineNo">355</span>    }<a name="line.355"></a>
<span class="sourceLineNo">356</span><a name="line.356"></a>
<span class="sourceLineNo">357</span>    /***<a name="line.357"></a>
<span class="sourceLineNo">358</span>     * Left-pad 8-character hex string with 0's<a name="line.358"></a>
<span class="sourceLineNo">359</span>     *<a name="line.359"></a>
<span class="sourceLineNo">360</span>     * @param buf - StringBuilder which is appended with leading 0's.<a name="line.360"></a>
<span class="sourceLineNo">361</span>     * @param l - a long.<a name="line.361"></a>
<span class="sourceLineNo">362</span>     */<a name="line.362"></a>
<span class="sourceLineNo">363</span>    private static void appendHexString(StringBuilder buf, long l)<a name="line.363"></a>
<span class="sourceLineNo">364</span>    {<a name="line.364"></a>
<span class="sourceLineNo">365</span>        String s = Long.toHexString(l);<a name="line.365"></a>
<span class="sourceLineNo">366</span>        for (int i = s.length(); i &lt; 8; i++) {<a name="line.366"></a>
<span class="sourceLineNo">367</span>            buf.append('0');<a name="line.367"></a>
<span class="sourceLineNo">368</span>        }<a name="line.368"></a>
<span class="sourceLineNo">369</span>        buf.append(s);<a name="line.369"></a>
<span class="sourceLineNo">370</span>    }<a name="line.370"></a>
<span class="sourceLineNo">371</span><a name="line.371"></a>
<span class="sourceLineNo">372</span>    /***<a name="line.372"></a>
<span class="sourceLineNo">373</span>     * Converts 64-bit NTP timestamp value to a &lt;code&gt;String&lt;/code&gt;.<a name="line.373"></a>
<span class="sourceLineNo">374</span>     * The NTP timestamp value is represented as hex string with<a name="line.374"></a>
<span class="sourceLineNo">375</span>     * seconds separated by fractional seconds by a decimal point;<a name="line.375"></a>
<span class="sourceLineNo">376</span>     * e.g. c1a089bd.fc904f6d &lt;=&gt; Tue, Dec 10 2002 10:41:49.986<a name="line.376"></a>
<span class="sourceLineNo">377</span>     *<a name="line.377"></a>
<span class="sourceLineNo">378</span>     * @return NTP timestamp 64-bit long value as hex string with seconds<a name="line.378"></a>
<span class="sourceLineNo">379</span>     * separated by fractional seconds.<a name="line.379"></a>
<span class="sourceLineNo">380</span>     */<a name="line.380"></a>
<span class="sourceLineNo">381</span>    public static String toString(long ntpTime)<a name="line.381"></a>
<span class="sourceLineNo">382</span>    {<a name="line.382"></a>
<span class="sourceLineNo">383</span>        StringBuilder buf = new StringBuilder();<a name="line.383"></a>
<span class="sourceLineNo">384</span>        // high-order second bits (32..63) as hexstring<a name="line.384"></a>
<span class="sourceLineNo">385</span>        appendHexString(buf, (ntpTime &gt;&gt;&gt; 32) &amp; 0xffffffffL);<a name="line.385"></a>
<span class="sourceLineNo">386</span><a name="line.386"></a>
<span class="sourceLineNo">387</span>        // low-order fractional seconds bits (0..31) as hexstring<a name="line.387"></a>
<span class="sourceLineNo">388</span>        buf.append('.');<a name="line.388"></a>
<span class="sourceLineNo">389</span>        appendHexString(buf, ntpTime &amp; 0xffffffffL);<a name="line.389"></a>
<span class="sourceLineNo">390</span><a name="line.390"></a>
<span class="sourceLineNo">391</span>        return buf.toString();<a name="line.391"></a>
<span class="sourceLineNo">392</span>    }<a name="line.392"></a>
<span class="sourceLineNo">393</span><a name="line.393"></a>
<span class="sourceLineNo">394</span>    /***<a name="line.394"></a>
<span class="sourceLineNo">395</span>     * Converts this &lt;code&gt;TimeStamp&lt;/code&gt; object to a &lt;code&gt;String&lt;/code&gt;<a name="line.395"></a>
<span class="sourceLineNo">396</span>     * of the form:<a name="line.396"></a>
<span class="sourceLineNo">397</span>     * &lt;blockquote&gt;&lt;pre&gt;<a name="line.397"></a>
<span class="sourceLineNo">398</span>     * EEE, MMM dd yyyy HH:mm:ss.SSS&lt;/pre&gt;&lt;/blockquote&gt;<a name="line.398"></a>
<span class="sourceLineNo">399</span>     * See java.text.SimpleDataFormat for code descriptions.<a name="line.399"></a>
<span class="sourceLineNo">400</span>     *<a name="line.400"></a>
<span class="sourceLineNo">401</span>     * @return  a string representation of this date.<a name="line.401"></a>
<span class="sourceLineNo">402</span>     */<a name="line.402"></a>
<span class="sourceLineNo">403</span>    public String toDateString()<a name="line.403"></a>
<span class="sourceLineNo">404</span>    {<a name="line.404"></a>
<span class="sourceLineNo">405</span>        if (simpleFormatter == null) {<a name="line.405"></a>
<span class="sourceLineNo">406</span>            simpleFormatter = new SimpleDateFormat(NTP_DATE_FORMAT, Locale.US);<a name="line.406"></a>
<span class="sourceLineNo">407</span>            simpleFormatter.setTimeZone(TimeZone.getDefault());<a name="line.407"></a>
<span class="sourceLineNo">408</span>        }<a name="line.408"></a>
<span class="sourceLineNo">409</span>        Date ntpDate = getDate();<a name="line.409"></a>
<span class="sourceLineNo">410</span>        return simpleFormatter.format(ntpDate);<a name="line.410"></a>
<span class="sourceLineNo">411</span>    }<a name="line.411"></a>
<span class="sourceLineNo">412</span><a name="line.412"></a>
<span class="sourceLineNo">413</span>    /***<a name="line.413"></a>
<span class="sourceLineNo">414</span>     * Converts this &lt;code&gt;TimeStamp&lt;/code&gt; object to a &lt;code&gt;String&lt;/code&gt;<a name="line.414"></a>
<span class="sourceLineNo">415</span>     * of the form:<a name="line.415"></a>
<span class="sourceLineNo">416</span>     * &lt;blockquote&gt;&lt;pre&gt;<a name="line.416"></a>
<span class="sourceLineNo">417</span>     * EEE, MMM dd yyyy HH:mm:ss.SSS UTC&lt;/pre&gt;&lt;/blockquote&gt;<a name="line.417"></a>
<span class="sourceLineNo">418</span>     * See java.text.SimpleDataFormat for code descriptions.<a name="line.418"></a>
<span class="sourceLineNo">419</span>     *<a name="line.419"></a>
<span class="sourceLineNo">420</span>     * @return  a string representation of this date in UTC.<a name="line.420"></a>
<span class="sourceLineNo">421</span>     */<a name="line.421"></a>
<span class="sourceLineNo">422</span>    public String toUTCString()<a name="line.422"></a>
<span class="sourceLineNo">423</span>    {<a name="line.423"></a>
<span class="sourceLineNo">424</span>        if (utcFormatter == null) {<a name="line.424"></a>
<span class="sourceLineNo">425</span>            utcFormatter = new SimpleDateFormat(NTP_DATE_FORMAT + " 'UTC'",<a name="line.425"></a>
<span class="sourceLineNo">426</span>                    Locale.US);<a name="line.426"></a>
<span class="sourceLineNo">427</span>            utcFormatter.setTimeZone(TimeZone.getTimeZone("UTC"));<a name="line.427"></a>
<span class="sourceLineNo">428</span>        }<a name="line.428"></a>
<span class="sourceLineNo">429</span>        Date ntpDate = getDate();<a name="line.429"></a>
<span class="sourceLineNo">430</span>        return utcFormatter.format(ntpDate);<a name="line.430"></a>
<span class="sourceLineNo">431</span>    }<a name="line.431"></a>
<span class="sourceLineNo">432</span><a name="line.432"></a>
<span class="sourceLineNo">433</span>    /***<a name="line.433"></a>
<span class="sourceLineNo">434</span>     * Compares two Timestamps numerically.<a name="line.434"></a>
<span class="sourceLineNo">435</span>     *<a name="line.435"></a>
<span class="sourceLineNo">436</span>     * @param   anotherTimeStamp - the &lt;code&gt;TimeStamp&lt;/code&gt; to be compared.<a name="line.436"></a>
<span class="sourceLineNo">437</span>     * @return  the value &lt;code&gt;0&lt;/code&gt; if the argument TimeStamp is equal to<a name="line.437"></a>
<span class="sourceLineNo">438</span>     *          this TimeStamp; a value less than &lt;code&gt;0&lt;/code&gt; if this TimeStamp<a name="line.438"></a>
<span class="sourceLineNo">439</span>     *          is numerically less than the TimeStamp argument; and a<a name="line.439"></a>
<span class="sourceLineNo">440</span>     *          value greater than &lt;code&gt;0&lt;/code&gt; if this TimeStamp is<a name="line.440"></a>
<span class="sourceLineNo">441</span>     *          numerically greater than the TimeStamp argument<a name="line.441"></a>
<span class="sourceLineNo">442</span>     *          (signed comparison).<a name="line.442"></a>
<span class="sourceLineNo">443</span>     */<a name="line.443"></a>
<span class="sourceLineNo">444</span>//    @Override<a name="line.444"></a>
<span class="sourceLineNo">445</span>    public int compareTo(TimeStamp anotherTimeStamp)<a name="line.445"></a>
<span class="sourceLineNo">446</span>    {<a name="line.446"></a>
<span class="sourceLineNo">447</span>        long thisVal = this.ntpTime;<a name="line.447"></a>
<span class="sourceLineNo">448</span>        long anotherVal = anotherTimeStamp.ntpTime;<a name="line.448"></a>
<span class="sourceLineNo">449</span>        return (thisVal &lt; anotherVal ? -1 : (thisVal == anotherVal ? 0 : 1));<a name="line.449"></a>
<span class="sourceLineNo">450</span>    }<a name="line.450"></a>
<span class="sourceLineNo">451</span><a name="line.451"></a>
<span class="sourceLineNo">452</span>}<a name="line.452"></a>




























































</pre>
</div>
</body>
</html>
